Allow specifying path to schema-sync folder with SCHEMA_SYNC_PATH #72

julbd · 2025-08-12T11:32:47Z

Add SCHEMA_SYNC_PATH environment variable allowing to specify/customize the path to schema-sync. By default : (Directus root)/schema-sync

Note : Initially, I planned to add a global cli option --path, but the current implementation with both global and command-scoped variables required too much refactoring.

julbd · 2025-08-13T09:41:23Z

@u12206050

Copilot

Pull request overview

This pull request adds support for customizing the path to the schema-sync folder via the SCHEMA_SYNC_PATH environment variable. By default, it continues to use (Directus root)/schema-sync.

Changes:

Introduced SCHEMA_SYNC_PATH environment variable to allow customization of the schema-sync folder location
Refactored ExportHelper static class into instance-based ExportMeta class to support configurable paths
Updated all components (SchemaExporter, CollectionExporter, ExportManager) to accept and use the configurable path

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/exportMeta.ts	New file containing the `ExportMeta` class with path configuration support, moved from `ExportHelper` in utils.ts
src/utils.ts	Removed `ExportHelper` class, extracted `fileExists` as a standalone utility function
src/types.ts	Added optional `path` parameter to `CollectionExporterOptions`
src/index.ts	Updated to instantiate `ExportMeta` with `SCHEMA_SYNC_PATH` and pass path to all exporters
src/exportManager.ts	Added `path` parameter to constructor and passes it to collection exporters
src/schemaExporter.ts	Added `path` option to constructor and uses `ExportMeta` for directory resolution
src/collectionExporter.ts	Updated to use `ExportMeta` with configurable path instead of static `ExportHelper`
src/updateManager.ts	Removed unused `ExportHelper` import
README.md	Added documentation for `SCHEMA_SYNC_PATH` environment variable and cleaned up trailing whitespace

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-11T12:10:29Z

src/exportMeta.ts

+    public schemaDir: string;
+
+    constructor(schemaDir?: string) {
+        this.schemaDir = resolve(process.cwd(), schemaDir ?? 'schema-sync')
+    }


Inconsistent indentation detected. The code uses spaces instead of tabs, which is inconsistent with the rest of the file. Lines 6-10 should use tabs for indentation to match the project's style.

Suggested change

public schemaDir: string;

constructor(schemaDir?: string) {

this.schemaDir = resolve(process.cwd(), schemaDir ?? 'schema-sync')

}

public schemaDir: string;

constructor(schemaDir?: string) {

this.schemaDir = resolve(process.cwd(), schemaDir ?? 'schema-sync')

}

Copilot · 2026-01-11T12:10:29Z

src/exportMeta.ts

+    public schemaDir: string;
+
+    constructor(schemaDir?: string) {
+        this.schemaDir = resolve(process.cwd(), schemaDir ?? 'schema-sync')
+    }
+
+    get dataDir() {
+        return resolve(this.schemaDir, 'data');
+    }
+
+    get hashFile() {
+        return resolve(this.schemaDir, 'hash.txt');
+    }
+
+    async updateExportMeta() {
+        const hasher = createHash('sha256');
+        const files = await readdir(this.dataDir);
+        for (const file of files) {
+            if (file.endsWith('.json')) {
+                const json = await readFile(`${this.dataDir}/${file}`, { encoding: 'utf8' });
+                hasher.update(json);
+            }
+        }
+        const hash = hasher.digest('hex');
+
+        const { hash: previousHash } = await this.getExportMeta() || {};
+
+        // Only update hash file if it has changed
+        if (hash === previousHash) return false;
+
+        const ts = utcTS();
+        const txt = hash + '@' + ts;
+
+        await writeFile(this.hashFile, txt);
+        return {
+            hash,
+            ts,
+        };
+    }
+
+    async getExportMeta() {
+        try {
+            const content = await readFile(this.hashFile, { encoding: 'utf8' });
+            const [hash, ts] = content.split('@');
+
+            if (hash && ts && new Date(ts).toString() !== 'Invalid Date') {
+                return {
+                    hash,
+                    ts,
+                };
+            }
+        } catch {
+            // ignore
+        }
+        return null;
+    }


Inconsistent indentation detected. The code uses spaces instead of tabs. The entire class body (lines 20-61) should use tabs for indentation to match the project's style.

Suggested change

public schemaDir: string;

constructor(schemaDir?: string) {

this.schemaDir = resolve(process.cwd(), schemaDir ?? 'schema-sync')

}

get dataDir() {

return resolve(this.schemaDir, 'data');

}

get hashFile() {

return resolve(this.schemaDir, 'hash.txt');

}

async updateExportMeta() {

const hasher = createHash('sha256');

const files = await readdir(this.dataDir);

for (const file of files) {

if (file.endsWith('.json')) {

const json = await readFile(`${this.dataDir}/${file}`, { encoding: 'utf8' });

hasher.update(json);

}

}

const hash = hasher.digest('hex');

const { hash: previousHash } = await this.getExportMeta() || {};

// Only update hash file if it has changed

if (hash === previousHash) return false;

const ts = utcTS();

const txt = hash + '@' + ts;

await writeFile(this.hashFile, txt);

return {

hash,

ts,

};

}

async getExportMeta() {

try {

const content = await readFile(this.hashFile, { encoding: 'utf8' });

const [hash, ts] = content.split('@');

if (hash && ts && new Date(ts).toString() !== 'Invalid Date') {

return {

hash,

ts,

};

}

} catch {

// ignore

}

return null;

}

public schemaDir: string;

constructor(schemaDir?: string) {

this.schemaDir = resolve(process.cwd(), schemaDir ?? 'schema-sync')

}

get dataDir() {

return resolve(this.schemaDir, 'data');

}

get hashFile() {

return resolve(this.schemaDir, 'hash.txt');

}

async updateExportMeta() {

const hasher = createHash('sha256');

const files = await readdir(this.dataDir);

for (const file of files) {

if (file.endsWith('.json')) {

const json = await readFile(`${this.dataDir}/${file}`, { encoding: 'utf8' });

hasher.update(json);

}

}

const hash = hasher.digest('hex');

const { hash: previousHash } = await this.getExportMeta() || {};

// Only update hash file if it has changed

if (hash === previousHash) return false;

const ts = utcTS();

const txt = hash + '@' + ts;

await writeFile(this.hashFile, txt);

return {

hash,

ts,

};

}

async getExportMeta() {

try {

const content = await readFile(this.hashFile, { encoding: 'utf8' });

const [hash, ts] = content.split('@');

if (hash && ts && new Date(ts).toString() !== 'Invalid Date') {

return {

hash,

ts,

};

}

} catch {

// ignore

}

return null;

}

Copilot · 2026-01-11T12:10:29Z

src/exportMeta.ts

+
+
+export function utcTS(isoTimestamp: string = new Date().toISOString()) {
+    return isoTimestamp.replace('T', ' ').replace(/\.\d*Z/, '');


Inconsistent indentation detected. The function uses spaces instead of tabs. Line 66 should use tabs for indentation to match the project's style.

Suggested change

return isoTimestamp.replace('T', ' ').replace(/\.\d*Z/, '');

return isoTimestamp.replace('T', ' ').replace(/\.\d*Z/, '');

Copilot · 2026-01-11T12:10:30Z

src/exportManager.ts

+	constructor(
+		protected path: string,
+		protected logger: ApiExtensionContext['logger']
+	) {	}


Extra whitespace in the constructor body. The closing brace should be on the line after the constructor parameters without extra whitespace or tabs before it.

Suggested change

) { }

) {}

Copilot · 2026-01-11T12:10:30Z

src/types.ts

 	query?: Pick<Query, 'filter' | 'sort' | 'limit'>;

+	// Path to the export folder
+	path?: string,


Missing trailing comma after the path property. Add a comma for consistency with the project's code style and to prevent potential issues when adding more properties.

Suggested change

path?: string,

path?: string;

Copilot · 2026-01-11T12:10:30Z

src/exportManager.ts


-	constructor(protected logger: ApiExtensionContext['logger']) {}
+	constructor(
+		protected path: string,


The parameter should accept string | undefined instead of just string. The value env.SCHEMA_SYNC_PATH being passed can be undefined when the environment variable is not set, which should be a valid scenario based on the documentation showing the default value.

Suggested change

protected path: string,

protected path: string | undefined,

feat: add SCHEMA_SYNC_PATH

e708e68

julbd changed the title ~~Add specifying path to schema-sync folder with SCHEMA_SYNC_PATH~~ Allow specifying path to schema-sync folder with SCHEMA_SYNC_PATH Aug 12, 2025

u12206050 requested a review from Copilot January 11, 2026 12:06

Copilot started reviewing on behalf of u12206050 January 11, 2026 12:07 View session

Copilot AI reviewed Jan 11, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow specifying path to schema-sync folder with SCHEMA_SYNC_PATH #72

Allow specifying path to schema-sync folder with SCHEMA_SYNC_PATH #72

Uh oh!

julbd commented Aug 12, 2025 •

edited

Loading

Uh oh!

julbd commented Aug 13, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 11, 2026

Uh oh!

Copilot AI Jan 11, 2026

Uh oh!

Copilot AI Jan 11, 2026

Uh oh!

Copilot AI Jan 11, 2026

Uh oh!

Copilot AI Jan 11, 2026

Uh oh!

Copilot AI Jan 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant



		export function utcTS(isoTimestamp: string = new Date().toISOString()) {
		return isoTimestamp.replace('T', ' ').replace(/\.\d*Z/, '');

Allow specifying path to schema-sync folder with SCHEMA_SYNC_PATH #72

Are you sure you want to change the base?

Allow specifying path to schema-sync folder with SCHEMA_SYNC_PATH #72

Uh oh!

Conversation

julbd commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

julbd commented Aug 13, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

julbd commented Aug 12, 2025 •

edited

Loading